Scripting a HyperLink

TheView includes a HyperLink method used to open a screen from a standard file system path or Blob path. This method has the following parameters:

FilePath

The path of the screen file. For standard file system files, use a "Path\File name" format. For Blob files, use a "Site.BSS\BSSGroup\File name" format.

SiteService

Optional site and service names to send to the new view (in "Site.Service" format). Use "" to pass no site/service name. This value is stored in the new view’s SiteService property.

FacilityID

Optional facility ID to send to the new view. Use a null ("") to pass no site/service name. This value is stored in the new view’s Facility property.

In the script below, which is executed when a Button named btnGoToMenu is clicked, the MainMenu.csf file is opened and assigned a site/service and facility. Furthermore, the Boolean return value of the method is stored in a variable (bOpen) and analyzed to determine whether or not to close the current screen. The return value is true if and only if the hyperlink successfully opened the new screen.

1
2
3
4
5
6
7
8
9
10
11
12
Sub btnGoToMenu_EventClick()
Dim This : Set This = btnGoToMenu
    Dim bOpen
     
    'Hyperlink to a new view. Store the result of the operation in the bOpen variable (optional)
    bOpen = TheView.HyperLink ("C:\CygNet\Clients\Studio\MainMenu.csf", "CYGDEMO.UIS", "OAKHILL")
     
    'If the hyperlink was successful (bOpen = True), close the current view.
    If bOpen Then
        TheView.Cancel
    End if
End Sub